/*-----------------------------------------------------------------------------
The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in
compliance with the License.You may obtain a copy of the License at
http://www.mozilla.org/MPL/MPL-1.1.html
	
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.
	
The Original Code is Fever RS ( ActionScript 3 ) Framework code.
	
The Initial Developer of the Original Code is Romain Ecarnot.
Portions created by Initial Developer are Copyright (C) 2006
the Initial Developer. All Rights Reserved.
	
Contributor(s):
	
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-----------------------------------------------------------------------------*/

package fever.events 
{
	import flash.events.Event;
	
	import com.bourre.events.BasicEvent;
	
	import fever.utils.browser.BrowserWindow;	

	/**
	 * The BrowserWindowEvent class represents the event object passed to the event 
	 * listener for <strong>BrowserWindow</strong> events.
	 * 
	 * @see fever.utils.browser.BrowserFrame	 * @see fever.utils.browser.BrowserPopup	 * @see fever.utils.browser.BrowserWindow
	 * 
	 * @author Romain Ecarnot
	 */
	final public class BrowserWindowEvent extends BasicEvent
	{
		//--------------------------------------------------------------------
		// Events
		//--------------------------------------------------------------------
		
		/**
		 * Defines the value of the <code>type</code> property of the event 
		 * object for a <code>onBrowserWindowOpen</code> event.
		 * 
		 * <p>The properties of the event object have the following values:</p>
	     *  <table class="innertable">
	     *     <tr><th>Property</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>target</code></td>
	     *     	<td>The Object that defines the event listener that handles the event</td>
	     *     </tr>
	     *     <tr>
	     *     	<td><code>type</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *     
	     *     <tr><th>Method</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>getTarget()</code>
	     *     	</td><td>The Object that defines the
	     *       event listener that handles the event</td></tr>
	     *     <tr>
	     *     	<td><code>getType()</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *      <tr>
	     *     	<td><code>getWindow()</code></td>
	     *     	<td>Browser window instance</td>
	     *     </tr>
	     *  </table>
	     * 
		 * @eventType onBrowserWindowOpen
		 */
		public static const onOpenEVENT : String = "onBrowserWindowOpen";
		
		/**
		 * Defines the value of the <code>type</code> property of the event 
		 * object for a <code>onBrowserWindowClose</code> event.
		 * 
		 * <p>The properties of the event object have the following values:</p>
	     *  <table class="innertable">
	     *     <tr><th>Property</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>target</code></td>
	     *     	<td>The Object that defines the event listener that handles the event</td>
	     *     </tr>
	     *     <tr>
	     *     	<td><code>type</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *     
	     *     <tr><th>Method</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>getTarget()</code>
	     *     	</td><td>The Object that defines the
	     *       event listener that handles the event</td></tr>
	     *     <tr>
	     *     	<td><code>getType()</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *      <tr>
	     *     	<td><code>getWindow()</code></td>
	     *     	<td>Browser window instance</td>
	     *     </tr>
	     *  </table>
	     * 
		 * @eventType onBrowserWindowClose
		 */
		public static const onCloseEVENT : String = "onBrowserWindowClose";
		
		
		//--------------------------------------------------------------------
		// Public API
		//--------------------------------------------------------------------
		
		/**
		 * Constructor.
		 * 
		 * @param pType Event type
		 * @param pStatus History status
		 */
		public function BrowserWindowEvent( pType : String, window : BrowserWindow = null )
		{
			super( pType, window );
		}
		
		/**
		 * Returns browser window source.
		 */
		public function getWindow() : BrowserWindow
		{
			return _oTarget as BrowserWindow;	
		}

		/**
		 * Returns <code>BrowserWindowEvent</code> clone instance.
		 */
		override public function clone() : Event
		{
			return new 	BrowserWindowEvent( _sType, getWindow() );
		}
	}
}
